Interface WirelessClientProcess

All Superinterfaces:
IPCObject, Process, WirelessCommon
All Known Implementing Classes:
WirelessClientProcessImpl

public interface WirelessClientProcess extends WirelessCommon
Information provided by the PKI file:

    \class WirelessClientProcess
    
    \brief WirelessClientProcess handles and manipulates wireless clients.
    
    \example network().getDevice("PC0").getProcess("WirelessClient")
    
Author:
Auto-generated
  • Method Details

    • addProfile

      boolean addProfile(String name, String ssid, WirelessNetworkType netType, MACAddress macAddress, WirelessAuthenType authType, WirelessEncryptType encryptType, String wepKey, String userid, String password, boolean bDHCPOn, boolean bDHCPv6On, IPAddress ipAddress, IPAddress subnet, IPAddress gateway, IPAddress DNS)
      Information provided by the PKI file:
      
          \brief Adds a wireless profile.
          
          \param name, the name for the wireless profile.
          \param ssid, the SSID of the access point.
          \param netType,     the network type.
          Network types:      eWirelessDisabled = 0x0,
          eWirelessB = 0x1,
          eWirelessG = 0x2,
          eWirelessBGMixed = 0x3,
          eWirelessN = 0x4,
          eWirelessA = 0x5,
          eWirelessMixed = 0x7
          \param macAddress, the MAC address of the access point.
          \param authType,    the authentication type.
          Authentication types:       eAuthenNull = 0,
          eAuthenWep = 1,
          eAuthenWPA1_PSK = 2,
          eAuthenWPA1_EAP = 3,
          eAuthenWPA2_PSK = 4,
          eAuthenWPA2_EAP = 5,
          eAuthenOpen = 6
          \param encryptType, the encryption type.
          Encryption types:   eEncryptNull = 0,
          eEncryptWep_64bit = 1,
          eEncryptWep_128bit = 2,
          eEncryptTKIP = 3,
          eEncryptAES = 4
          \param wepKey, the WEP key.
          \param userid, the user ID for WPA enterprise.
          \param password, the password for WPA enterprise.
          \param bDHCPOn, true to enable DHCP, false to disable DHCP.
          \param bDHCPv6On, true to enable DHCPv6, false to disable DHCPv6.
          \param ipAddress, the IP address for the interface.
          \param subnet, the subnet mask for the interface.
          \param gateway, the default gateway for the interface.
          \param DNS, the DNS server for the interface.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      name - Takes in a parameter of name
      ssid - Takes in a parameter of ssid
      netType - Takes in a parameter of netType
      macAddress - Takes in a parameter of macAddress
      authType - Takes in a parameter of authType
      encryptType - Takes in a parameter of encryptType
      wepKey - Takes in a parameter of wepKey
      userid - Takes in a parameter of userid
      password - Takes in a parameter of password
      bDHCPOn - Takes in a parameter of bDHCPOn
      bDHCPv6On - Takes in a parameter of bDHCPv6On
      ipAddress - Takes in a parameter of ipAddress
      subnet - Takes in a parameter of subnet
      gateway - Takes in a parameter of gateway
      DNS - Takes in a parameter of DNS
      Returns:
      boolean Returns a boolean
    • deleteProfile

      boolean deleteProfile(String name)
      Information provided by the PKI file:
      
          \brief Deletes the wireless profile with the specified name.
          
          \param name, the name of the wireless profile of interest.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      name - Takes in a parameter of name
      Returns:
      boolean Returns a boolean
    • getProfile

      WirelessProfile getProfile(String name)
      Information provided by the PKI file:
      
          \brief Returns the wireless profile with the specified name.
          
          \param name, the name of the wireless profile of interest.
          
          \return WirelessProfile, the WirelessProfile object with the specified name.
          
              
      Parameters:
      name - Takes in a parameter of name
      Returns:
      WirelessProfile Returns a WirelessProfile
    • getProfileCount

      int getProfileCount()
      Information provided by the PKI file:
      
          \brief Returns the number of wireless profiles.
          
          \return int, the number of wireless profiles.
          
              
      Returns:
      int Returns a int
    • getProfileAt

      WirelessProfile getProfileAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the wireless profile at the specified index.
          
          \param index, the index of the wireless profile of interest.
          
          \return WirelessProfile, the WirelessProfile object at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      WirelessProfile Returns a WirelessProfile
    • getCurrentProfile

      WirelessProfile getCurrentProfile()
      Information provided by the PKI file:
      
          \brief Returns the current wireless profile.
          
          \return WirelessProfile, the WirelessProfile object.
          
              
      Returns:
      WirelessProfile Returns a WirelessProfile
    • setCurrentProfile

      boolean setCurrentProfile(String name, String ssid, WirelessNetworkType netType, MACAddress macAddress, WirelessAuthenType authType, WirelessEncryptType encryptType, String wepKey, String userid, String password, boolean bDHCPOn, boolean bDHCPv6On, IPAddress ipAddress, IPAddress subnet, IPAddress gateway, IPAddress DNS)
      Information provided by the PKI file:
      
          \brief Sets the current wireless profile with the specified settings.
          
          \param name, the name for the wireless profile.
          \param ssid, the SSID of the access point.
          \param netType,     the network type.
          Network types:      eWirelessDisabled = 0x0,
          eWirelessB = 0x1,
          eWirelessG = 0x2,
          eWirelessBGMixed = 0x3,
          eWirelessN = 0x4,
          eWirelessA = 0x5,
          eWirelessMixed = 0x7
          \param macAddress, the MAC address of the access point.
          \param authType,    the authentication type.
          Authentication types:       eAuthenNull = 0,
          eAuthenWep = 1,
          eAuthenWPA1_PSK = 2,
          eAuthenWPA1_EAP = 3,
          eAuthenWPA2_PSK = 4,
          eAuthenWPA2_EAP = 5,
          eAuthenOpen = 6
          \param encryptType, the encryption type.
          Encryption types:   eEncryptNull = 0,
          eEncryptWep_64bit = 1,
          eEncryptWep_128bit = 2,
          eEncryptTKIP = 3,
          eEncryptAES = 4
          \param wepKey, the WEP key.
          \param userid, the user ID for WPA enterprise.
          \param password, the password for WPA enterprise.
          \param bDHCPOn, true to enable DHCP, false to disable DHCP.
          \param bDHCPv6On, true to enable DHCPv6, false to disable DHCPv6.
          \param ipAddress, the IP address for the interface.
          \param subnet, the subnet mask for the interface.
          \param gateway, the default gateway for the interface.
          \param DNS, the DNS server for the interface.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      name - Takes in a parameter of name
      ssid - Takes in a parameter of ssid
      netType - Takes in a parameter of netType
      macAddress - Takes in a parameter of macAddress
      authType - Takes in a parameter of authType
      encryptType - Takes in a parameter of encryptType
      wepKey - Takes in a parameter of wepKey
      userid - Takes in a parameter of userid
      password - Takes in a parameter of password
      bDHCPOn - Takes in a parameter of bDHCPOn
      bDHCPv6On - Takes in a parameter of bDHCPv6On
      ipAddress - Takes in a parameter of ipAddress
      subnet - Takes in a parameter of subnet
      gateway - Takes in a parameter of gateway
      DNS - Takes in a parameter of DNS
      Returns:
      boolean Returns a boolean
    • setCurrentProfileStringIPs

      boolean setCurrentProfileStringIPs(String name, String ssid, WirelessNetworkType netType, String macAddress, WirelessAuthenType authType, WirelessEncryptType encryptType, String wepKey, String userId, String password, boolean bDHCPOn, boolean bDHCPv6On, String ipAddress, String subnet, String gateway, String DNS)
      Parameters:
      name - Takes in a parameter of name
      ssid - Takes in a parameter of ssid
      netType - Takes in a parameter of netType
      macAddress - Takes in a parameter of macAddress
      authType - Takes in a parameter of authType
      encryptType - Takes in a parameter of encryptType
      wepKey - Takes in a parameter of wepKey
      userId - Takes in a parameter of userId
      password - Takes in a parameter of password
      bDHCPOn - Takes in a parameter of bDHCPOn
      bDHCPv6On - Takes in a parameter of bDHCPv6On
      ipAddress - Takes in a parameter of ipAddress
      subnet - Takes in a parameter of subnet
      gateway - Takes in a parameter of gateway
      DNS - Takes in a parameter of DNS
      Returns:
      boolean Returns a boolean
    • getCurrentNetworkCount

      int getCurrentNetworkCount()
      Information provided by the PKI file:
      
          \brief Returns the number of current network wireless profiles.
          
          \return int, the number of current networks wireless profiles.
          
              
      Returns:
      int Returns a int
    • getCurrentNetworkAt

      WirelessProfile getCurrentNetworkAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the current network wireless profile at the specified index.
          
          \param index, the index of the current network wireless profile of interest.
          
          \return WirelessProfile, the WirelessProfile object at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      WirelessProfile Returns a WirelessProfile
    • getCurrentApMac

      MACAddress getCurrentApMac()
      Information provided by the PKI file:
      
          \brief Returns the MAC address of the current access point.
          
          \return mac, the MAC address of the current access point.
          
              
      Returns:
      MACAddress Returns a MACAddress